用户扩展属性(CustomProperty)

[GET] /api/v2/identity/custom-properties

获取所有扩展属性。

响应

状态代码: 200

成功

CustomizePropertyBizModel

[POST] /api/v2/identity/custom-properties

添加一个新的扩展属性。

请求模式

CustomPropertyCreationModel

响应

状态代码: 201

成功

CustomizePropertyBizModel

状态代码: 400

错误请求

ApiErrorResult

[GET] /api/v2/identity/custom-properties/{id}

获取指定的扩展属性的信息。

参数

名称	类型	位置	描述
id必填项	string	path	扩展属性的id。

响应

状态代码: 200

成功

CustomizePropertyBizModel

状态代码: 404

未发现

ApiErrorResult

[DELETE] /api/v2/identity/custom-properties/{id}

删除指定的扩展属性。

参数

名称	类型	位置	描述
id必填项	string	path	扩展属性ID。

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未发现

ApiErrorResult

[PUT] /api/v2/identity/custom-properties/{id}

更新指定的扩展属性的信息。

参数

名称	类型	位置	描述
id必填项	string	path	扩展属性ID。

请求模式

CustomPropertyUpdateModel

响应

状态代码: 200

成功

CustomizePropertyBizModel

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未发现

ApiErrorResult

[POST] /api/v2/identity/custom-properties/{id}/available-values-validation

验证指定的扩展属性的新的可用值。

参数

名称	类型	位置	描述
id必填项	string	path	扩展属性ID。

请求模式

CustomPropertyAvailableValuesModel

响应

状态代码: 200

成功

CustomPropertyAvailableValuesValidationModel

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未发现

ApiErrorResult

模型定义

Ƭ CustomizePropertyBizModel

名称	类型	描述	示例
id可为空	string
name可为空	string
showInList可为空	Boolean
allowUserEdit可为空	Boolean
multivalued可为空	Boolean
showInProfile可为空	Boolean
availableValues可为空	Array<string>

Ƭ ApiErrorResult

用来描述处理网络请求时发生的所有错误的模型。

名称	类型	描述	示例
errors可为空	ApiError	错误列表。

Ƭ ApiError

用来描述处理网络请求时发生的错误的模型。

名称	类型	描述	示例
code可为空	string	错误的唯一标识。
message可为空	string	错误的描述文字。
context可为空	string	该错误的一些相关的背景信息。

Ƭ CustomPropertyCreationModel

名称	类型	描述	示例
name	string	The custom property name.	"Gender"
showInList可为空	Boolean	是否在用户列表中显示该扩展属性。	true
allowUserEdit可为空	Boolean	是否允许用户编辑这个扩展属性。	true
multivalued可为空	Boolean	该扩展属性是否为多值属性。
showInProfile可为空	Boolean	是否在用户资料页面中显示此扩展属性。	true
availableValues可为空	Array<string>	该扩展属性的可用值。	["male","female"]

Ƭ CustomPropertyUpdateModel

名称	类型	描述	示例
name	string	The custom property name.	"Gender"
showInList可为空	Boolean	是否在用户列表中显示该扩展属性。	true
allowUserEdit可为空	Boolean	是否允许用户编辑这个扩展属性。	true
multivalued可为空	Boolean	该扩展属性是否为多值属性。
showInProfile可为空	Boolean	是否在用户资料页面中显示此扩展属性。	true
availableValues可为空	Array<string>	该扩展属性的可用值。	["male","female"]

Ƭ CustomPropertyAvailableValuesValidationModel

名称	类型	描述	示例
hasInvalidValues	Boolean	Whether there are some invalid values.
invalidValues可为空	Array<string>	无效值列表。

Ƭ CustomPropertyAvailableValuesModel

名称	类型	描述	示例
availableValues	Array<string>	扩展属性的可用值。	["male","female"]